Skip to main content
Search

Receiver Update API 3 - PII Verify Result Update

Where should I integrate?​

Receiver Update API 3 - PII Verification​

This API is for Receiver VASPs who will respond with a pending state to the Travel Rule. It allows you to perform the verification step manually in a separate process.

*If you don't have a pending flow, you can skip this implementation.

To Use​

To use this API, the requestId must exist beforehand because someone (Initiator VASP) has initiated the request and is at the PII verification stage: callbackType=4. You replied as pending (verifyStatus: 100002), and when you finish the manual verification, reply with the status via this API. GTR will help notify the Initiator VASP.

API Request​

The usage and explanation are the same as the Callback API in the previous chapter. Please refer to: Receiver Callback API 3 - PII Verification

POST /api/verify/v2/manual/verify_pii

Request Payload - PII Verify Success

{
    "requestId": "[REQUEST-ID]",
    "result": {
        "verifyStatus": 100000,
        "verifyMessage": "PII Verification Success",
        "data": {
            "preflightCheckMessage": "",
            "preflightCheckStatus": "REJECTED"
            "verifyFields": [
                {
                    "message": "matched (success)",
                    "status": 1, 
                    "type": "111001" 
                },
                {
                    "message": "mismatch (failed)",
                    "status": 2, 
                    "type": "111022" 
                }
            ],
            "piiSecuredInfo": {
                "initiatorKeyInfo": {
                    "publicKey": "[COUNTER_PARTY_VASP_PUBLIC_KEY]"
                },
                "receiverKeyInfo": {
                    "publicKey": "[YOUR_PUBLIC_KEY]"
                },
                "piiSecretFormatType": "FULL_JSON_OBJECT_ENCRYPT",
                "piiSpecVersion": "ivms101-2020",
                "secretAlgorithm": "ed25519_curve25519",
                "securedPayload": "[Encrypted PII, clear-text is forbidden]"
            }
        }
    }
}

Request Payload - PII Verify Failed

{
    "requestId": "[REQUEST-ID]",
    "result": {
        "verifyStatus": 200003,
        "verifyMessage": "PII Verification Failed",
        "data": {
            "preflightCheckMessage": "",
            "preflightCheckStatus": "REJECTED"
            "verifyFields": [
                {
                    "message": "matched (success)",
                    "status": 1, 
                    "type": "111001" 
                },
                {
                    "message": "mismatch (failed)",
                    "status": 2, 
                    "type": "111022" 
                }
            ],
            "piiSecuredInfo": {
                "initiatorKeyInfo": {
                    "publicKey": "[COUNTER_PARTY_VASP_PUBLIC_KEY]"
                },
                "receiverKeyInfo": {
                    "publicKey": "[YOUR_PUBLIC_KEY]"
                },
                "piiSecretFormatType": "FULL_JSON_OBJECT_ENCRYPT",
                "piiSpecVersion": "ivms101-2020",
                "secretAlgorithm": "ed25519_curve25519",
                "securedPayload": "[Encrypted PII, clear-text is forbidden]"
            }
        }
    }
}